Skip to content

docs(grid): fix demo date format error #3515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 17, 2025
Merged

docs(grid): fix demo date format error #3515

merged 1 commit into from
Jun 17, 2025

Conversation

gimmyhehe
Copy link
Member

@gimmyhehe gimmyhehe commented Jun 17, 2025

PR

修复demo日期格式化问题

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • Bug Fixes

    • Updated date format configuration in grid columns to use the correct property name, ensuring dates are displayed as intended.
  • Tests

    • Adjusted test cases to check for fully formatted date strings, improving accuracy of date display validation.

Copy link

coderabbitai bot commented Jun 17, 2025

Walkthrough

The updates standardize the date format configuration across three grid column components by renaming the property from valueFormat to dateFormat in both the implementation and its demo. Corresponding test assertions are revised to check for fully formatted date strings instead of partial fragments.

Changes

Files Change Summary
.../grid/renderer/inner-renderer-date-composition-api.vue,
.../inner-renderer-date.vue
Renamed format-config property from valueFormat to dateFormat in three grid column components.
.../grid/renderer/inner-renderer-date.spec.js Updated test assertions to check for full date strings instead of partial fragments.

Poem

In grids where dates once danced astray,
A rabbit hopped in to tidy the way.
From valueFormat to dateFormat—so neat!
Now dates appear whole, a formatting treat.
The tests all agree, with a thump of delight,
The calendar’s clearer—oh what a sight!
🗓️🐇

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

examples/sites/demos/pc/app/grid/renderer/inner-renderer-date-composition-api.vue

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

examples/sites/demos/pc/app/grid/renderer/inner-renderer-date.spec.js

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

examples/sites/demos/pc/app/grid/renderer/inner-renderer-date.vue

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@gimmyhehe gimmyhehe linked an issue Jun 17, 2025 that may be closed by this pull request
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

♻️ Duplicate comments (1)
examples/sites/demos/pc/app/grid/renderer/inner-renderer-date.vue (1)

10-17: Same dateFormat/valueFormat concern as the Composition API version

Replicate whichever resolution you choose there to keep the two demos in sync.

Also applies to: 22-22

🧹 Nitpick comments (3)
examples/sites/demos/pc/app/grid/renderer/inner-renderer-date-composition-api.vue (1)

31-40: Avoid locale-ambiguous literals in the example data

Storing dates as strings like '07/02/2024' is ambiguous (US vs EU order) and forces the reader to reverse-engineer the intended pattern. Consider ISO-8601 ('2024-07-02') or numeric timestamps everywhere and rely solely on format-config for visual formatting.
This keeps the demo focused on rendering rather than parsing edge-cases.

examples/sites/demos/pc/app/grid/renderer/inner-renderer-date.vue (1)

37-45: ISO-8601 input for clearer intent

Same remark as above about ambiguous literals; using ISO strings avoids confusion and makes the example safer to copy-paste into different locales.

examples/sites/demos/pc/app/grid/renderer/inner-renderer-date.spec.js (1)

6-9: Assert complete, unambiguous strings for all dates

Great update for date3 & date5. For consistency, assert the full string for date1 as well instead of the fragment '-07-02'; fragments can pass even when the actual formatting regresses.

-await expect(page.getByText('-07-02').first()).toBeVisible()
+await expect(page.getByText('2024-07-02').first()).toBeVisible()

This keeps the test deterministic and resilient to unrelated layout/text changes.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5ed29bf and 10345e9.

📒 Files selected for processing (3)
  • examples/sites/demos/pc/app/grid/renderer/inner-renderer-date-composition-api.vue (1 hunks)
  • examples/sites/demos/pc/app/grid/renderer/inner-renderer-date.spec.js (1 hunks)
  • examples/sites/demos/pc/app/grid/renderer/inner-renderer-date.vue (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: PR E2E Test (pnpm test:e2e3)
🔇 Additional comments (1)
examples/sites/demos/pc/app/grid/renderer/inner-renderer-date-composition-api.vue (1)

10-17: Confirm that dateFormat is the canonical prop name

The demo switches from valueFormat to dateFormat. ⚠️ TinyGrid historically consumed valueFormat, so double-check that the underlying renderer has already been upgraded to accept dateFormat; otherwise the column will silently fall back to its default formatting.

If the core component still expects valueFormat, either:

-:format-config="{ dateFormat: 'dd/MM/yyyy' }"
+:format-config="{ valueFormat: 'dd/MM/yyyy' }"

or expose a compatibility layer in the renderer.

Also applies to: 22-22

@zzcr zzcr merged commit d8c2c96 into dev Jun 17, 2025
10 of 11 checks passed
@zzcr zzcr deleted the cgm/fix-date-format branch June 17, 2025 01:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🐛 [Bug]: Grid组件内置的日期渲染器格式没生效
2 participants